/**
 * Copyright (C) 2007 The AsyncMail Group <asyncmail@googlegroups.com>
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *         http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.googlecode.asyncmail.queue;

import java.util.Iterator;

public interface MailQueue {

    /**
     * Add MailQueue item to queue and return true if successfully
     * 
     * @param qItem
     * @return
     */
    public boolean addMailQueueItem(MailQueueItem qItem);

    /**
     * Remove the given MailQueueItem
     * 
     * @param qItem
     * @return
     */
    public boolean removeMailQueueItem(MailQueueItem qItem);

    /**
     * Return the next MailQueueItem which should be processed
     * 
     * @return
     */
    public MailQueueItem getNextMailQueueItem();

    /**
     * Return a List of all MailQueueItems
     * 
     * @return
     */
    public Iterator<MailQueueItem> getProcessingMailQueueItems();

    /**
     * Return the Size of the queue
     * 
     * @return
     */
    public int getProcessingMailQueueSize();

    public int getWaitingMailQueueSize();

    public Iterator<MailQueueItem> getWaitingMailQueueItems();

    public void flushQueue();

    public boolean contains(MailQueueItem qItem);
}
